/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.graph.drivers.input;

import org.apache.flink.api.java.ExecutionEnvironment;
import org.apache.flink.graph.Graph;
import org.apache.flink.graph.drivers.parameter.Parameterized;
import org.apache.flink.graph.generator.GraphGenerator;

/**
 * Input source for a {@link Graph}, for example a file reader or {@link GraphGenerator}.
 *
 * @param <K> graph ID type
 * @param <VV> vertex value type
 * @param <EV> edge value type
 */
public interface Input<K, VV, EV> extends Parameterized {

    /**
     * A human-readable identifier summarizing the input and configuration.
     *
     * @return the input identifier
     */
    String getIdentity();

    /**
     * Create the input {@link Graph}.
     *
     * @param env the ExecutionEnvironment
     * @return the input Graph
     */
    Graph<K, VV, EV> create(ExecutionEnvironment env) throws Exception;
}
